SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Go

Go static code analysis

Unique rules to find Bugs, Vulnerabilities, Security Hotspots, and Code Smells in your GO code

  • All rules 94
  • Vulnerability21
  • Bug13
  • Security Hotspot14
  • Code Smell46
 
Tags
    Impact
      Clean code attribute
        1. Context should not be stored in struct fields

           Code Smell
        2. Context parameters should be reused instead of creating new background contexts

           Code Smell
        3. Package imports should be consistent and avoid redundancy

           Code Smell
        4. Variables should be used

           Code Smell
        5. Consecutive function parameters with the same type should be grouped

           Code Smell
        6. Named types should be used instead of anonymous structs for complex nested structures

           Code Smell
        7. Use "bytes.Equal" instead of "bytes.Compare" for equality checks

           Code Smell
        8. Single-method interface names should follow Go naming conventions

           Code Smell
        9. Variables in if short statements should be used beyond just the condition

           Code Smell
        10. Context cancellation functions should be deferred

           Code Smell
        11. Blank imports should be documented to explain their purpose

           Code Smell
        12. Function and method names should not use "Get" prefix

           Code Smell
        13. Semicolons should not be used unnecessarily

           Code Smell
        14. Import statements should be factored into a single block

           Code Smell
        15. Functions should follow Go's explicit error handling patterns

           Code Smell
        16. Multi-line comments should not be empty

           Code Smell
        17. Functions should not have identical implementations

           Code Smell
        18. Cognitive Complexity of functions should not be too high

           Code Smell
        19. Go parser failure

           Code Smell
        20. Boolean checks should not be inverted

           Code Smell
        21. Two branches in a conditional structure should not have exactly the same implementation

           Code Smell
        22. "switch" statements should not be nested

           Code Smell
        23. "switch" statements should not have too many "case" clauses

           Code Smell
        24. Track lack of copyright and license headers

           Code Smell
        25. Functions and methods should not have too many lines

           Code Smell
        26. Control flow statements "if", "for" and "switch" should not be nested too deeply

           Code Smell
        27. Octal values should not be used

           Code Smell
        28. "switch" statements should have "default" clauses

           Code Smell
        29. "if ... else if" constructs should end with "else" clauses

           Code Smell
        30. Statements should be on separate lines

           Code Smell
        31. String literals should not be duplicated

           Code Smell
        32. Functions should not be empty

           Code Smell
        33. Unused function parameters should be removed

           Code Smell
        34. Local variable and function parameter names should comply with a naming convention

           Code Smell
        35. "switch case" clauses should not have too many lines

           Code Smell
        36. Track uses of "TODO" tags

           Code Smell
        37. Track uses of "FIXME" tags

           Code Smell
        38. Boolean literals should not be redundant

           Code Smell
        39. Empty statements should be removed

           Code Smell
        40. Redundant pairs of parentheses should be removed

           Code Smell
        41. Nested blocks of code should not be left empty

           Code Smell
        42. Functions should not have too many parameters

           Code Smell
        43. Expressions should not be too complex

           Code Smell
        44. Files should not have too many lines of code

           Code Smell
        45. Lines should not be too long

           Code Smell
        46. Function names should comply with a naming convention

           Code Smell

        Context should not be stored in struct fields

        consistency - conventional
        maintainability
        Code Smell
        • convention

        This rule raises an issue when context.Context is declared as a field in a struct type.

        Why is this an issue?

        How can I fix it?

        More Info

        Storing context.Context in struct fields goes against Go best practices and creates several problems.

        When you store context in a struct, you obscure its lifetime to callers. This makes it unclear when the context will be used and how long it will remain valid. Callers cannot understand the scope of the context just by looking at the API.

        Storing context in structs also prevents per-call customization. Each method call should be able to specify its own deadline, cancellation behavior, and metadata. When context is stored in a struct, all method calls share the same context, removing this flexibility.

        This design intermingles different scopes in unpredictable ways. The context’s lifetime becomes tied to the struct’s lifetime rather than individual operations. This can lead to contexts outliving their intended use or being cancelled unexpectedly.

        The Go documentation explicitly states: "Contexts should not be stored inside a struct type, but instead passed to each function that needs it." This guidance ensures contexts remain scoped to specific operations and maintain their intended purpose of carrying request-scoped values, deadlines, and cancellation signals.

        What is the potential impact?

        Storing context in structs reduces the flexibility and clarity of your API. Callers lose the ability to set per-call deadlines, request cancellation for specific operations, or attach operation-specific metadata.

        This can lead to poor resource management, as contexts may outlive their intended scope or be shared inappropriately between operations. In production systems, this can result in requests that cannot be properly cancelled, potentially leading to resource leaks or degraded performance.

        The API becomes confusing for users who cannot easily understand when and how the stored context will be used, requiring additional documentation and potentially leading to misuse.

          Available In:
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories

        © 2025 SonarSource Sàrl. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use